feat: Introduce User Report Section on Moderation Console #30554

Dnouv · 2023-10-03T12:43:04Z

Proposed changes (including videos or screenshots)

Introduce a new window (tab, to be precise) on the Moderation Console to view and manage reported users.

Added:

A new tab for Reported Users is now available on the Moderation Console page.
A new endpoint has been added to retrieve user reports by user ID.
A new endpoint has been added to dismiss user reports by user ID.
A new endpoint has been added to fetch all the user reports grouped by unique users.
A new component has been added to show user report details on the Contextual Bar.
A new common filter component ModFilter can be used in both the User & Message Reports.
A few i18n have been added.

Changed:

Replaced useRoute with useRouter on the Moderation Console page.
Added reported user name and username columns to the Moderation Console table.
Shortened long file names, e.g., "ModConsoleReportDetails" instead of "ModerationConsoleReportDetails".
Improved the no results page view with more informative messages for each tab.
Changed the Date filters to a dropdown with pre-defined options, rather than a date selector, for better i18n.
Added an isUserReport prop to the useDismissUserAction to enable dismissing user reports as well as message reports.
Updated the useResetAvatarAction with more calls to invalidate react-queries.
Renamed the ReportMessageHistoryParams to GetUserReportsParams, for more clarity.

APIs

API Endpoint: moderation.dismissUserReports

Description

This endpoint allows a moderator to dismiss user reports. The moderator could provide a reason and an action for the dismissal.

Method: POST

Parameters

userId: The ID of the user whose reports are to be dismissed.
reason: The reason for dismissing the reports.
action: The action taken upon dismissing the reports.

Response

success: A boolean indicating if the operation was successful.
message: A message indicating the result of the operation.

API Endpoint: moderation.user.reportsByUserId

Description

This endpoint retrieves all the moderation reports for a specific user.

Method: GET

Query Parameters

userId: The ID of the user whose reports are to be retrieved.
selector: (Optional) A string to filter the reports.
count: (Optional) The number of reports to retrieve. Default is 50.
offset: (Optional) The number of reports to skip before starting to retrieve. Default is 0.

Response

success: A boolean indicating if the operation was successful.
user: The user object.
reports: An array of report objects.
count: The number of reports returned.
total: The total number of reports.
offset: The offset value.

API Endpoint: moderation.userReports

Description

This endpoint retrieves all the user reports.

Method: GET

Query Parameters

latest: (Optional) The latest date (in ISO format) from which to retrieve reports. Default is the current date.
oldest: (Optional) The oldest date (in ISO format) from which to retrieve reports. Default is the date of the oldest report.
selector: (Optional) A string to filter the reports.
count: (Optional) The number of reports to retrieve. Default is 20.
offset: (Optional) The number of reports to skip before starting to retrieve. Default is 0.

Response

success: A boolean indicating if the operation was successful.
reports: An array of report objects.
count: The number of reports returned.
total: The total number of reports.
offset: The offset value.

Issue(s)

Steps to test or reproduce

This video shows the main features of the product:

-moderation_console_userreport.mp4

Further comments

AECO-336

To the reviewer:

This PR might look a bit large at first glance, and you might think it could be split into smaller ones. However, from my experience with similar changes in the past, I’ve found that keeping everything in one PR actually makes the review and testing process easier.
That being said, I understand this might not be the most convenient approach for everyone. So, my apologies if this causes any inconvenience during your review. Thanks for your understanding and patience as you go through this PR. 🙏

…eraiton model

changeset-bot · 2023-10-03T12:43:08Z

🦋 Changeset detected

Latest commit: 0868710

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 32 packages

Name	Type
@rocket.chat/model-typings	Minor
@rocket.chat/rest-typings	Minor
@rocket.chat/i18n	Minor
@rocket.chat/meteor	Minor
@rocket.chat/models	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
rocketchat-services	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/api-client	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/presence	Patch
@rocket.chat/mock-providers	Patch
@rocket.chat/web-ui-registration	Major
@rocket.chat/cron	Patch
@rocket.chat/instance-status	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/gazzodown	Major
@rocket.chat/ui-client	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/uikit-playground	Patch
@rocket.chat/livechat	Patch
@rocket.chat/core-typings	Minor
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codecov · 2023-10-03T12:53:46Z

Codecov Report

Attention: 21 lines in your changes are missing coverage. Please review.

Comparison is base (da410ef) 59.83% compared to head (0868710) 49.57%.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop   #30554       +/-   ##
============================================
- Coverage    59.83%   49.57%   -10.27%     
============================================
  Files         1793     3320     +1527     
  Lines        34892    81614    +46722     
  Branches      7268    16773     +9505     
============================================
+ Hits         20879    40460    +19581     
- Misses       12411    36435    +24024     
- Partials      1602     4719     +3117

Flag	Coverage Δ
e2e	`53.22% <100.00%> (+0.06%)`	⬆️
e2e-api	`40.70% <74.07%> (?)`
unit	`76.47% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

apps/meteor/app/api/server/v1/moderation.ts

…on.userReports)

apps/meteor/app/api/server/v1/moderation.ts

AllanPazRibeiro

LGTM

sampaiodiego

tests can be improved later during the release candidate cycle.. the other change requests should be very simple to get done before the cut. 😉

apps/meteor/app/api/server/v1/moderation.ts

.changeset/rare-eels-fetch.md

apps/meteor/server/models/raw/ModerationReports.ts

apps/meteor/app/api/server/v1/moderation.ts

apps/meteor/tests/end-to-end/api/27-moderation.ts

Co-authored-by: Diego Sampaio <[email protected]>

Dnouv added 5 commits September 26, 2023 18:54

add method to fetch reported users

3e0d4eb

revamp the date filter and revert back the leftover change on the mdo…

d612b0f

…eraiton model

add the tabs on main console

ab39e74

add hide user reports endpoint

790423f

complete the user reports context bar display

cdaaa36

dionisio-bot bot added the stat: needs QA label Oct 3, 2023

debdutdeb requested changes Oct 3, 2023

View reviewed changes

apps/meteor/app/api/server/v1/moderation.ts Show resolved Hide resolved

apps/meteor/app/api/server/v1/moderation.ts Outdated Show resolved Hide resolved

Dnouv and others added 11 commits October 5, 2023 18:37

fix ts error & improve the count

21d6068

add refresh avatar for user section & i18n

0e499b6

add tests & rename api endpoint (moderation.user.reports <-> moderati…

23f02f7

…on.userReports)

Merge branch 'develop' into new/MCreptUser

0089077

componentize the mod filter & use userouter

87a72f9

abstract & improve

5bd4bfd

Merge branch 'develop' into new/MCreptUser

4a5f9f3

remove re-render key

a4d1a05

remove & resolve comments, fix sort, and a few cleanup

ca91e40

add changeset

24ee102

reset the default tab to Messages

3758269

Dnouv marked this pull request as ready for review October 13, 2023 12:49

Dnouv requested review from a team as code owners October 13, 2023 12:49

AllanPazRibeiro suggested changes Oct 16, 2023

View reviewed changes

apps/meteor/app/api/server/v1/moderation.ts Show resolved Hide resolved

casalsgh and others added 2 commits October 17, 2023 14:32

Merge branch 'develop' into new/MCreptUser

4d54a1a

define methods for API calls

a288c85

AllanPazRibeiro previously approved these changes Oct 17, 2023

View reviewed changes

Merge branch 'develop' into new/MCreptUser

22da12d

casalsgh requested a review from debdutdeb October 18, 2023 11:57

Merge develop

4a8b316

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: conflict labels Jan 22, 2024

fix TS

6187d71

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 22, 2024

sampaiodiego requested changes Jan 22, 2024

View reviewed changes

Update apps/meteor/server/models/raw/ModerationReports.ts

1727f05

Co-authored-by: Diego Sampaio <[email protected]>

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 22, 2024

Dnouv added 2 commits January 22, 2024 19:08

change api name & remove try...catch

96233f0

change changeset

e0ad38a

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 22, 2024

revert api name

9e48dfc

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 22, 2024

sampaiodiego approved these changes Jan 22, 2024

View reviewed changes

tassoevan approved these changes Jan 22, 2024

View reviewed changes

Merge branch 'develop' into new/MCreptUser

4690b20

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 23, 2024

Merge branch 'develop' into new/MCreptUser

0868710

dionisio-bot bot added stat: ready to merge PR tested and approved waiting for merge and removed stat: ready to merge PR tested and approved waiting for merge labels Jan 23, 2024

kodiakhq bot merged commit 2260c04 into develop Jan 23, 2024
44 of 45 checks passed

kodiakhq bot deleted the new/MCreptUser branch January 23, 2024 13:25

rocketchat-github-ci mentioned this pull request Feb 1, 2024

Release 6.6.0 #31556

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce User Report Section on Moderation Console #30554

feat: Introduce User Report Section on Moderation Console #30554

Dnouv commented Oct 3, 2023 •

edited

Loading

changeset-bot bot commented Oct 3, 2023 •

edited

Loading

codecov bot commented Oct 3, 2023 •

edited

Loading

AllanPazRibeiro left a comment

sampaiodiego left a comment

feat: Introduce User Report Section on Moderation Console #30554

feat: Introduce User Report Section on Moderation Console #30554

Conversation

Dnouv commented Oct 3, 2023 • edited Loading

Proposed changes (including videos or screenshots)

APIs

Description

Method: POST

Parameters

Response

Description

Method: GET

Query Parameters

Response

Description

Method: GET

Query Parameters

Response

Issue(s)

Steps to test or reproduce

Further comments

changeset-bot bot commented Oct 3, 2023 • edited Loading

🦋 Changeset detected

codecov bot commented Oct 3, 2023 • edited Loading

Codecov Report

AllanPazRibeiro left a comment

Choose a reason for hiding this comment

sampaiodiego left a comment

Choose a reason for hiding this comment

Dnouv commented Oct 3, 2023 •

edited

Loading

changeset-bot bot commented Oct 3, 2023 •

edited

Loading

codecov bot commented Oct 3, 2023 •

edited

Loading